chore: Update proc_installing-che-on-openshift-with-keycloak-as-oidc.…#3112
chore: Update proc_installing-che-on-openshift-with-keycloak-as-oidc.…#3112tolusha wants to merge 2 commits into
Conversation
…adoc Signed-off-by: Anatolii Bazko <abazko@redhat.com>
|
@gtrivedi88 |
|
@gtrivedi88 |
| ... Click *Next*. | ||
| .. On the *Login settings* page: | ||
| + | ||
| ... Entry `{prod-short}` redirect URL in the *Valid redirect URIs* field. |
There was a problem hiding this comment.
Typo: "Entry" should be "Enter"
American English grammar issue - should be the imperative verb "Enter" not the noun "Entry".
Fix: "Enter {prod-short} redirect URL in the Valid redirect URIs field."
| ... Click *Next*. | ||
| .. On the *Login settings* page: | ||
| + | ||
| ... Entry `{prod-short}` redirect URL in the *Valid redirect URIs* field. |
There was a problem hiding this comment.
JTBD Logic Flow Issue: User needs redirect URL before this step
This step asks users to enter the redirect URL but doesn't explain how to get it until the NOTE block several lines later. This breaks the user journey flow.
Suggested fix: Move the NOTE block (lines 44-54) to appear before step 1, or add a reference here like:
"Enter {prod-short} redirect URL (see NOTE below for command to obtain this URL) in the Valid redirect URIs field."
This follows JTBD principle of providing users with information when they need it.
| ---- | ||
|
|
||
| . Create a secret for the OAuth client in the {prod-short} namespace: | ||
| . Create a Secret: |
There was a problem hiding this comment.
CQA 2.1 Issue: Step title too vague
"Create a Secret" doesn't tell users what the secret is for. CQA 2.1 requires clear, descriptive step titles that help users understand the purpose.
Suggested: "Create a Secret for OAuth authentication"
This makes the purpose clear and follows CQA 2.1 guidance for user-centric step descriptions.
There was a problem hiding this comment.
CQA 2.1 Violation: Abstract format issue
The abstract should use WHY-first format per CQA 2.1 standards.
Current: "To manage user authentication through a centralized identity provider, deploy {prod-short}..."
Fix: "To enable centralized user authentication through an external identity provider, install {prod-short} on {orch-name} with {keycloak} as the OIDC provider."
Changes needed:
- WHY (enable centralized auth) should come first
- "deploy" → "install" to match procedure title
|
🎊 Navigate the preview: https://6a28165669f55b169eb877df--eclipse-che-docs-pr.netlify.app 🎊 |
|
Remarks have been addressed. |
…adoc
What does this pull request change?
Updates
proc_installing-che-on-openshift-with-keycloak-as-oidcWhat issues does this pull request fix or reference?
eclipse-che/che#23831
Specify the version of the product this pull request applies to
main
Pull Request checklist
The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.
Validate language on files added or modifiedstep reports no vale warnings.